以【Task】sprint 1-開發後端: 資料後續的crud操作這張「Task 卡片」為例 :

開發的過程中有遭遇

• /insertdata 的 spring boot annotation 要如何設定
• /updatedata 的 spring boot annotation 要如何設定
• /deletedata 的 spring boot annotation 要如何設定
• /usddata 的 spring boot annotation 要如何設定

因此，文件本身的重點就是要聚焦在上述的問題解決。

【重點提示】

(X) 不好的寫法。
原因在於在網頁上閱讀的話，還要拖拉水平滑棒才能看到最右邊的程式碼片段。另外，HackMD免費版的圖片，一定時間該篇文章如果沒人瀏覽，圖片就會消失。因此，還是轉出PDF檔比較保險。

(O) 好的寫法。
其實只要對程式碼做適當的縮排，整個閱讀上就會很舒服。這樣的顯示即便匯出成PDF檔，也不怕會有程式碼遺漏。
線上HTML轉出PDF的工具可以參考: HTML轉換至 PDF。

整個文件範例 :

...

以 Restful api 的開發架構來說，個人會補上每個 POSTMAN 的對應測試結果。

個人是以寫出baeldung這種等級的開發文件為目標。

最後，這類對應每個 Story 而產出的開發文件，與有做版控程式碼放在同一個資料夾下是可以的。一般我是習慣在project資料夾下命名一個doc的資料夾存放。